﻿<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="ja">
<head>
<title>S_ExpandParameter</title>
<LINK REL="stylesheet" TYPE="text/css" HREF="../../sakura.css">
<meta http-equiv="Content-type" content="text/html; charset=UTF-8">
</head>
<small>
Sakura-Editor Macro Reference
</small>
<h2>S_ExpandParameter</h2>
<dl>
	<dt>機能</dt>
		<dd>特殊文字の展開</dd>
	<dt>構文</dt>
		<dd><em>string  S_ExpandParameter ( S1 )</em>&nbsp;&nbsp;<a href="../../sample/SampleExpandParameter.html">使用例</a>
		<br><br>
		<table border="1" cellspacing="0" cellpadding="3" width="85%">
	<caption style="display: none">無題</caption>
<tr><th scope="auto">引数</th><th scope="auto">型</th><th scope="auto">内容</th></tr>
			<tr><td>S1</td><td>文字列</td><td>フォーマット文字列 </td></tr>
		</table>
		</dd>
	<dt>設定値</dt>
		<dd>引数&nbsp;<em>S1</em>&nbsp;の設定値は次のとおりです。<br><br>
		<table border="1" cellspacing="0" cellpadding="3" width="85%">
	<caption style="display: none">無題</caption>
<tr><th scope="auto">値</th><th scope="auto">内容</th></tr>
			<tr><td>$$ </td><td>文字 $ 自身 </td></tr>
			<tr><td>$F </td><td>開いているファイルの名前（フルパス） </td></tr>
			<tr><td>$f </td><td>開いているファイルの名前（ファイル名+拡張子のみ）</td></tr>
			<tr><td>$g </td><td>開いているファイルの名前（拡張子を除くファイル名のみ） </td></tr>
			<tr><td>$/ </td><td>開いているファイルの名前（フルパス。パスの区切りが / ） </td></tr>
			<tr><td>$N </td><td>開いているファイルの名前（「共通設定⇒ファイル名表示」の設定で置換された表記） </td></tr>
			<tr><td>$S </td><td>サクラエディタ本体のフルパス </td></tr>
			<tr><td>$M </td><td>実行中のマクロファイルのフルパス </td></tr>
			<tr><td>$C </td><td>選択中のテキストまたはカーソル位置の単語 </td></tr>
			<tr><td>$x </td><td>現在の物理桁位置(先頭からのバイト数)(1開始) </td></tr>
			<tr><td>$y </td><td>現在の物理行位置(1開始) </td></tr>
			<tr><td>$d </td><td>現在の日付(共通設定の日付書式) </td></tr>
			<tr><td>$t </td><td>現在の時刻(共通設定の時刻書式) </td></tr>
			<tr><td>$D </td><td>開いているファイルのタイムスタンプ(共通設定の日付書式) </td></tr>
			<tr><td>$T </td><td>開いているファイルのタイムスタンプ(共通設定の時刻書式) </td></tr>
			<tr><td>$V </td><td>サクラエディタのバージョン </td></tr>
			<tr><td>$h </td><td>Grep検索キーの先頭32byteまで </td></tr>
		</table>
		</dd>
	<dt>説明</dt>
		<dd>
		フォーマット文字列に従った文字列を取得する。フォーマット文字列中の $ で始まる文字が特定の情報文字列に置き換わる。
		</dd>
	<dt>条件文</dt>
		<dd>
		フォーマット文字列中に条件文を記述することも可能である。条件文は入れ子に記述する事も出来る。<br><br>
		条件文書式：$｛ｃ?A0$：A1$：A2$：．．．$｝<br>
		条件 ｃ に対応して A0，A1，A2 ．．． のいずれかの文字列が返される。条件 ｃ として用意されている物は以下の通り。<br>
		<table border="1" cellspacing="0" cellpadding="3" width="85%">
	<caption style="display: none">無題</caption>
<tr><th scope="auto">条件</th><th scope="auto">動作</th></tr>
			<tr><td>R</td><td>エディタ上で読み取り専用で開いている $： 上書き禁止のファイル $： いずれでもない </td></tr>
			<tr><td>w</td><td>Grep検索結果ウィンドウ $： アウトプットウィンドウ $： 普通のウィンドウ </td></tr>
			<tr><td>M</td><td>キーボードマクロ記録中 $： 記録中ではない </td></tr>
			<tr><td>U</td><td>更新されている $： 更新されていない </td></tr>
			<tr><td>I</td><td>エディタウィンドウがアクティブではない $： エディタウィンドウがアクティブ </td></tr>
		</table>
		</dd>
		<dd>
		<dl>
			<dt>読み取り専用
			<dd>メニューで ファイル(F) → ファイル操作(R) → 読み取り専用(O) の操作</dd>
			<dt>上書き禁止</dt>
			<dd>ファイルの読み取り専用属性がON，他のアプリケーションが排他で開いている</dd>
		</dl>
		</dd>
	<dt>補足</dt>
		<dd>
		新規ファイル，Grep検索結果ウィンドウ，アウトプットウィンドウの場合、$F，$f，$g，$/ は「(無題)」に、$D，$T は「(保存されていません)」になる。
		<hr>
		次の２つは同じ結果になる<br>
		<ul>
			<li>str ：= S_ExpandParameter( '$F' )；</li>
			<li>str ：= S_GetFilename( )；</li>
		</ul>
		<hr>
		$C は「検索ダイアログを出した時に、検索の“条件”欄に取り込まれる文字列」と同じ文字列になる。つまり次のような仕様である。<br>
		<ul>
			<li>文字列が範囲選択されている場合、その選択されている文字列が取得される。</li>
			<li>文字列が範囲選択されていない場合、カーソル位置の単語が取得される。</li>
			<li>複数行を選択してあっても、取得されるのは一番上の１行のみであり、改行を含まない。</li>
			<li>取得できる文字列は 259 バイトまでである。</li>
		</ul>
		<br>
		次の２つは同じ結果とは限らない<br>
		<ul>
			<li>str ：= S_ExpandParameter( '$C' )；</li>
			<li>str ：= S_GetSelectedString(0)；</li>
		</ul>
		</dd>
	<dt>関連項目</dt>
		<dd>
		<a href="./S_GetSelectedString.html">S_GetSelectedString()</a>
		<a href="./S_GetFilename.html">S_GetFilename()</a>
		<a href="../support/S_About.html">S_About()</a>
		</dd>
</dl>
<hr>
</body></html>
